0.3.0 - Second STU ballot

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: PatientDeidentSTU3

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-deident-stu3

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Patient

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 15 elements

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*CRD Deidentified Patient
... text 0..0
... identifier 0..0
... name 0..0
... telecom 0..0
... gender S1..1code
... birthDate S0..1date
... deceased[x] 0..0
... address S0..*Address
.... use 0..1code
.... type S0..1code
.... text 0..0
.... line 0..0
.... city 0..0
.... district 0..0
.... state S0..1string
.... postalCode 0..0
.... country S0..1string
.... period 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication S0..*BackboneElement
.... language S1..1CodeableConcept
... link 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*CRD Deidentified Patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this patient's record is in active use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date of birth for the individual
... address SΣ0..*AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... animal ?!ΣI0..1BackboneElementThis patient is known to be an animal (non-human)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication SI0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Common Languages (extensible)
Max Binding: All Languages
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record

doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 15 elements

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*CRD Deidentified Patient
... text 0..0
... identifier 0..0
... name 0..0
... telecom 0..0
... gender S1..1code
... birthDate S0..1date
... deceased[x] 0..0
... address S0..*Address
.... use 0..1code
.... type S0..1code
.... text 0..0
.... line 0..0
.... city 0..0
.... district 0..0
.... state S0..1string
.... postalCode 0..0
.... country S0..1string
.... period 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication S0..*BackboneElement
.... language S1..1CodeableConcept
... link 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*CRD Deidentified Patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!Σ0..1booleanWhether this patient's record is in active use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date of birth for the individual
... address SΣ0..*AddressAddresses for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... animal ?!ΣI0..1BackboneElementThis patient is known to be an animal (non-human)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication SI0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Common Languages (extensible)
Max Binding: All Languages
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Patient.genderrequiredAdministrativeGender
Patient.address.typerequiredAddressType
Patient.communication.languageextensibleCommon Languages
Max Binding: All Languages

Constraints

IdPathDetailsRequirements
dom-2PatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1PatientIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4PatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3PatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Patient.animalAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Patient.communicationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())